home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 98 / Skunkware 98.iso / src / devtools / automake-1.0.tar.gz / automake-1.0.tar / automake-1.0 / TODO < prev    next >
Text File  |  1996-05-30  |  13KB  |  354 lines
  1. Priorities for release:
  2.   [ none ]
  3.  
  4. consider supporting "var+= stuff" syntax.  rewrite to just var=... on
  5. output.  This is sometimes convenient when you want to write a
  6. Makefile.am in more-or-less modular parts
  7.  
  8. dejagnu support:
  9. * create site.exp based on known things: tool, srcdir, objdir,
  10.   maybe host_alias, host_triplet, target_alias, target_triplet,
  11.   build_triplet (depending on whether AC_CANONICAL_* is used)
  12. * use RUNTEST_FOR_TARGET in some cases?
  13. * defining RUNTEST, RUNTESTFLAGS should require dejagnu option
  14.  
  15. should be able to determine what is built by looking at rules (and
  16. configure.in).  Then built man pages (eg) could automatically be
  17. omitted from the distribution.
  18.  
  19. Consider using libfoo_SOURCES, etc, for libraries.  From Gord
  20. Matzigkeit.  There is a patch.
  21.  
  22. Idea from Joerg-Martin Schwarz: allow passing different -D flags to
  23. different compiles.  This can be done, but with the restriction that a
  24. .c cannot appear in 2 different "objects" (programs/libraries)
  25. compiled with different -D options (because -c and -o do not always
  26. work together and parallel makes must work).  This could be
  27. implemented by noticing whenever a ".o" target with no rules is being
  28. emitted, and adding the appropriate compilation rule as appropriate.
  29. This should work with targets from Makefile.am as well as from .P
  30. files, which means rewriting so that the Makefile.am contents aren't
  31. copied into the output immediately.  This feature is probably required
  32. to fully support libtool ("grody compilation issue")
  33.  
  34. If @LIBOBJS@ or @ALLOCA@ appears in _LDADD or _LIBADD, put it into
  35. dependencies automatically
  36.  
  37. Man pages can be generated
  38.  
  39. * ansi2knr.c needs STDC_HEADERS and HAVE_STRING_H
  40.   [ I've asked Franτois about this.  The change should probably
  41.     be in the fp_C_PROTOTYPES macro ]
  42.  
  43. Think about: maybe "make check" should just bomb if error occurs?
  44. Then user must use "make -k check".  This is probably more natural.
  45.  
  46. Consider: should Gnits require jm_MAINTAINER_MODE?
  47.  
  48. Consider: "cvs" option adds some cvs-specific rules?
  49.  
  50. Consider adding an option that statically rewrites @MAINT@ to "#M#".
  51. (this would be useful at Cygnus)
  52.  
  53.  
  54. Automake and Cygnus: info target separate from all.  Always make
  55. install-info target.  install-info separate from install.
  56.  
  57. Automake: should EXTRA_DIST files be statically findable?
  58.  
  59. Automake: devo/inet/Makefile.am has "all-local".  "install" depends on
  60. "all", but the local installs get run before the stuff in "all".  Gross.
  61.  
  62. Right now, targets generated internally (eg "install") are not
  63. overridable by user code.  This should probably be possible, even
  64. though it isn't very important.  This could be done by generating all
  65. internal rules via a function call instead of just appending to
  66. $output_rules.
  67.  
  68. * Should be a way to have "nobuild_PROGRAMS" which aren't even built,
  69.   but which could be by running the magic make command.
  70.  
  71. * Should have tool like "autoreconf" that only remakes Makefiles that
  72.   need it.  Probably autoreconf should be modified to handle automake
  73.  
  74. Other priorities:
  75. * Must rewrite am_install_var.  Should break into multiple functions.
  76.   This will allow the callers to be a little smarter.
  77. * Rewrite clean targets.
  78. * Must rewrite error handling code.  Right now it is a real mess
  79.   Should fix up require_file junk at the same time
  80.  
  81. Things to finish libtool support:
  82. * Handle grody compilation issue
  83. * Handle install changes
  84. * Handle clean changes
  85. * New definition for LINK
  86.  
  87. Scan source directories and warn about missing files, eg .c/.h files
  88. that aren't mentioned?
  89.  
  90. Currently gettext requires @INTLSUB@ and @POSUB@ in SUBDIRS.  In the
  91. future this will be just intl and po.  When that happens, re-enable
  92. warnings in handle_subdirs.
  93.  
  94. Need way to say there are no suffixes in a Makefile (Franc,ois'
  95. "override" idea suffices here)
  96.  
  97. Check to make sure various scripts are executable (IE when looking for
  98. them in a directory)
  99.  
  100. Think about ways to make automake fit better with Cygnus-style trees.
  101.  
  102. Use recode in dist target when MAINT_CHARSET specified.  Read caveats
  103. in automake.in before doing this.  Note the same problem used to apply
  104. to the no-dependencies option; maybe it still should?  Note also that
  105. each Makefile.am must be rewritten at "make dist" time if
  106. MAINT_CHARSET and DIST_CHARSET are not identical.  NOTE: gettext must
  107. arrange for all .po files not to be recoded.  In the long term this
  108. might be a problem (consider when some systems use Unicode but the
  109. rest do not)
  110.   MAINT_CHARSET *must* be local to each Makefile.am, to enable
  111.     merged distributions.
  112.   DIST_CHARSET must be passed down to subdir makes during a "make dist"
  113.  
  114. Handle dist-zoo.  Generally add more DOS support.  Maybe run "doschk"
  115. (why isn't this merged with "pathchk"?) when doing a dist.  Do
  116. whatever else Franτois says here...
  117.  
  118. Add support for html via an option.  Use texi2html.  Use
  119. "html_TEXINFOS", and htmldir = .../html.  Include html files in
  120. distribution.  Also allow "html_DATA", for raw .html files.
  121.   [ when will texinfo support html? ]
  122.  
  123. uninstall and pkg-dirs should rm -rf the dir.
  124.  
  125. a potential bug: configure puts "blah.o" into LIBOBJS, thus implying
  126. these files can't be de-ansified.  Not a problem?
  127.  
  128. In general most .am files should be merged into automake.  For
  129. instance all the "clean" targets could be merged by keeping lists of
  130. things to be removed.  This would be a lot nicer looking.  Note that
  131. the install targets probably should not be merged; it is sometimes
  132. useful to only install a small part.
  133.  
  134. Clean up the output:
  135. * Order rules sensibly
  136. * Ensure every line has a purpose.  Omit unused stuff
  137. * Eliminate extraneous rules when possible (eg 'install-am' stuff)
  138. * Make sure vertical spacing is correct
  139. * pretty-print targets
  140. * regularize how backslash-newline is done.  Just one space between text
  141.   and backslash should be the rule.  Update makefile-mode to allow this.
  142.   (set column to 0, probably)
  143. Omit program transform vars from header if no program installed.  This
  144. is currently pretty hard to do.  (But with beautification code it
  145. would probably be easy)
  146.  
  147. It should be possible to have ansi2knr in just one place in a package.
  148. Jim Meyering says just rely on configure to make links as appropriate.
  149. Maybe introduce syntax like this:
  150.     AUTOMAKE_OPTIONS = ../ansi2knr
  151. ?  Consider putting it into AC_CONFIG_AUX_DIR
  152.  
  153. Lex, yacc support:
  154. * It would be nice to automatically support using bison's better features
  155.   to rename the output files.  This requires autoconf support
  156. * Consider supporting syntax from autoconf "derived:source", eg:
  157.     y.tab.c:perly.y
  158.   for yacc and lex source
  159. * if AC_PROG_LEX used, ensure LEXLIB is in foo_LDADD
  160. * require AC_DECL_YYTEXT for lex
  161.  
  162. require AC_PROG_CXX if any C++ source files found?
  163. Better support for C++ all around
  164.  
  165. Write autoconf macro to do all work necessary for automake.  Eg define
  166. PACKAGE, VERSION, etc.
  167.  
  168. 'maintainer-clean' should "rm -rf .deps".  Ditto distclean
  169. Should look for clean-local targets in Makefile.am.
  170.  
  171. It might be cool to generate .texi dependencies by grepping for
  172. @include.  (If done, it should be done the same way C dependencies are
  173. done)
  174.  
  175. It would be good to check some parts of GNU standards.  Already check
  176. for install-sh and mkinstalldirs.  What else is required to be in
  177. package by GNU standards or by automake?
  178. Some things for --strictness=gnits:
  179. * "cd $(foo); something" is an error in a rule.  Should be:
  180.   "cd $(foo) && something"
  181. * Look for 'ln -s' and warn about using $(LN) and AC_PROG_LN_S
  182. * Look for $(LN) and require AC_PROG_LN_S
  183.  
  184. automake.in: should ".cc" really -> "$o"?  This doesn't really seem
  185. right, but maybe it is so names can be rewritten uniformly?  Must
  186. check
  187.  
  188. Auto-distribute "ChangeLog.[0-9]+"?  "ChangeLog.[a-z]+"?
  189.  
  190. Internationalize. [ gettext doesn't have the necessary machinery yet ]
  191. am_error should use printf-style arguments (for eventual gettext scheme)
  192.  
  193. Franτois says the ordering of files in a distribution should be as follows:
  194. * README
  195. * source files
  196. * derived files
  197. I agree, but I don't see how to implement this yet.
  198. It might be easier if "derived files" is limited to those that
  199. Automake itself knows about, eg output of yacc.
  200.  
  201. Check all source files to make sure that FSF address is up-to-date.
  202. --gnits or --gnu only.
  203.  
  204. Merge each -vars.am file with corresponding ".am" file.  Can do this
  205. because of changes to &file_contents.
  206.  
  207. Looked at a program called 'ezmake', which seems to do something
  208. similar.  The only idea there that is possibly worth stealing is using
  209. globs in definitions.  Also has negations.  Eg in a directory with
  210. files a.c, b.c and c.c, the line:
  211.     foo_SOURCES = *.c ~c.c
  212. would be equivalent to:
  213.     foo_SOURCES = a.c b.c
  214. Is this worth implementing?
  215.  
  216. Should libexec programs have the name transform done on them?
  217.  
  218. Order the output rules sensibly, so FOO_SOURCES and FOO_OBJECTS are
  219. together and rules are in the usual order.
  220.  
  221. Make the output minimal: only output definitions for variables that
  222. are used.
  223.  
  224. Look at dist's jmake for ideas.  dist is the name of the distribution
  225. including Metaconfig.  Perl uses it.
  226.  
  227. Should handle directory hierarchies deeper than 2.  Right now there is
  228. some support for this.  Here are some of the issues:
  229. * Should handle AC_CONFIG_SUBDIRS, ie must handle configure.in in subdirs
  230. * Must handle SUBDIRS in subdir Makefile.am's
  231.  
  232. These can both be handled via dist-hook:
  233. . Consider supporting guile-style PLUGIN directories automatically?
  234. . Consider allowing eg "foo/bar" to appear in EXTRA_DIST, and generating
  235.   code to make directory foo at dist time
  236.  
  237. ================================================================
  238.  
  239. Document:
  240.  
  241.  
  242. Defined variables, their meanings, and their effects:
  243.  
  244. DEFS           cpp definitions
  245. INCLUDES       -I options to cpp
  246. CPPFLAGS       more cpp flags
  247. CFLAGS         flags to cc
  248. COMPILE           how to compile a C program
  249. LINK           how to link a C program
  250.  
  251. DIST_SUBDIRS   directories which are copied verbatim into the
  252.                distribution.  Used eg for directories holding
  253.                only example code (which don't have their own
  254.                makefile).  This variable might be a bad idea.
  255.   [ should just require a new Makefile.am.  They are supposed to be
  256.     easy to write ]
  257.  
  258. Document customary ordering of Makefile.am.  From Franτois.
  259.  
  260. must document that @ALLOCA@ works in _LDADD
  261.  
  262. Must document BUILT_SOURCES variable.  See depend.am.
  263.  
  264. Should include extended version of diagram from Autoconf (suggested by
  265. Greg Woods)
  266.  
  267. Must document macros which can be used when writing one's own rules.
  268. Must document INCLUDES
  269.  
  270. Document gettext support
  271.  
  272. Make a definition of the term "source"
  273.  
  274. need xref to libtool in docs
  275.  
  276. document how to use Automake with CVS.  Idea from Mark Galassi.  Also
  277. include Greg Woods' more sophisticated "cvs-dist" target.
  278.  
  279. document that there is no uninstall-{exec,data}
  280.  
  281. document rebuilding configure.  CONFIGURE_DEPENDENCIES
  282.  
  283. document TAGS_DEPENDENCIES
  284.  
  285. ================================================================
  286.  
  287. Libraries:
  288.  
  289. * Should support standalone library along with subdir library in same
  290.   Makefile.am.  Maybe: turn off "standalone" mode if library's Makefile.am
  291.   is not only one specd? [ add an option for this ]
  292.  
  293. ================================================================
  294.  
  295. Longer term:
  296.  
  297. Have a program that generates a Makefile on stdout, passes it through
  298. a "config.status"-style filter, and thence into make.  Why bother,
  299. other than the gee-whiz factor?
  300.  
  301. It might be interesting to figure out how a GNU system could use
  302. Makefile.am's without resorting to Automake.  This might be impossible
  303. in a practical sense.
  304.  
  305. Would it be useful to integrate in some way with the Debian package
  306. building utility?  Must check.  maybe it would be possible to deal
  307. with all the different package utilities somehow.  Lately I've been
  308. hearing good things about the RedHat packaging utilities.  Why are
  309. there so many of these?  Are they fun to write or something?
  310. The RedHat package utility is called RPM; see
  311.     ftp://ftp.redhat.com/pub/code/rpm
  312. It actually has problems, like no configure script and no documentation.
  313.  
  314. ================================================================
  315.  
  316. A tool to guess what the local Makefile.am should look like:
  317.  
  318. * Probably integrate with autoscan
  319. * Use various simple rules to determine what to do:
  320.   * get name of top directory, sans version info
  321.   * search for .c files with 'main' in them
  322.     * if in main.c, use directory name for program
  323.     * if in more than one, generate multiple programs
  324.     * if not found, generate a library named after directory
  325.   * order subdir searches correctly: lib first, src last
  326.   * assume 'testsuite' dir means we are using dejagnu
  327. * maybe be smart about reading existing Makefile.am, so tool
  328.   can be run for incremental changes?  You could imagine:
  329.  
  330.     Makefile.am:
  331.         autoproject --incremental
  332.  
  333. ================================================================
  334.  
  335. Stuff NOT to do, and why:
  336.  
  337. consider auto-including any file that matches "*.in".
  338.   [ no: po/Makefile.in shouldn't be included ]
  339.  
  340. must look at mkid to see how it works (for subdir usage)
  341.   [ right now, it doesn't.  i don't see a simple fix right now ]
  342.  
  343. if configure.in not found, move up a directory and try again?  This
  344. could eliminate a common source of problems.
  345.   [ this is just a bad idea ]
  346.  
  347. * scripts are installed in $exec_prefix/bin, not $prefix/bin
  348.   Bug or feature?
  349.   [ the consensus on Gnits is that this isn't required.
  350.     doubters can work around it anyway ]
  351.  
  352. * make the auto-dep code crash if GNU make not in use?
  353.   (doesn't it already?)
  354.